home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / stdio / RCS / tmpnam.man,v < prev    next >
Text File  |  1989-10-03  |  3KB  |  113 lines
  1. head     1.2;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.2
  10. date     89.10.03.17.29.09;  author shirriff;  state Exp;
  11. branches ;
  12. next     1.1;
  13.  
  14. 1.1
  15. date     89.01.05.17.00.09;  author ouster;  state Exp;
  16. branches ;
  17. next     ;
  18.  
  19.  
  20. desc
  21. @@
  22.  
  23.  
  24. 1.2
  25. log
  26. @changed tmpname to tempnam.
  27. @
  28. text
  29. @' Copyright 1989 Regents of the University of California
  30. ' Permission to use, copy, modify, and distribute this
  31. ' documentation for any purpose and without fee is hereby
  32. ' granted, provided that this notice appears in all copies.
  33. ' The University of California makes no representations about
  34. ' the suitability of this material for any purpose.  It is
  35. ' provided "as is" without express or implied warranty.
  36. ' 
  37. ' $Header: /sprite/src/lib/c/stdio/RCS/tmpnam.man,v 1.1 89/01/05 17:00:09 ouster Exp Locker: shirriff $ SPRITE (Berkeley)
  38. ' 
  39. .so \*(]ltmac.sprite
  40. .HS tmpnam lib
  41. .BS
  42. .SH NAME
  43. tmpnam, tempnam \- Generate unique names for temporary files
  44. .SH SYNOPSIS
  45. .nf
  46. \fBinclude <stdio.h>
  47.  
  48. \fBchar *
  49. tmpnam(\fIs\fR)
  50.  
  51. \fBchar *
  52. tempnam(\fIdir\fR, \fIprefix\fR)
  53. .SH ARGUMENTS
  54. .AS char *prefix
  55. .AP char *s    in/out
  56. Place to store temporary file name.  If \fBNULL\fR, store name in local
  57. static storage that will be overwritten on next call to \fBtmpnam\fR.
  58. If not \fBNULL\fR, \fIs\fR must point to a buffer containing
  59. at least \fBL_tmpnam\fR bytes.
  60. .AP char *dir    in
  61. Directory in which to temporary file should reside.  If \fBNULL\fR,
  62. or if \fIdir\fR is not an accessible directory, defaults to \fBP_tmpdir\fR.
  63. .AP char *prefix in
  64. First few letters to use for name of temporary file.
  65. .BE
  66.  
  67. .SH DESCRIPTION
  68. .PP
  69. The procedures \fBtmpnam\fR and \fBtempnam\fR generate unique file
  70. names suitable for temporary files.  Each procedure returns a pointer
  71. to the name it generated, except that under some conditions (such
  72. as inability to allocate memory, for example) \fBtempnam\fR will
  73. fail to generate a file name.  When this happens, \fBtempnam\fR will
  74. return \fBNULL\fR.
  75. .PP
  76. \fBTmpnam\fR generates file names that refer to a standard directory
  77. defined by \fBP_tmpdir\fR (currently \fB/usr/tmp\fR).  Each time
  78. \fBtmpnam\fR is called it will return a different file name, which
  79. does not refer to any existing file.
  80. .PP
  81. \fBTempnam\fR is similar to \fBtmpnam\fR except that it provides
  82. more flexibility.  The \fIdir\fR argument may be used to specify
  83. a particular directory to which the generated name should refer.
  84. If this is not an accessible directory, then \fBP_tmpdir\fR will
  85. be used.  If this directory is not accessible either, then
  86. \fB/tmp\fR will be used as a last resort.  If the \fBTMPDIR\fR
  87. environment variable is defined and refers to an accessible
  88. directory, then it will override any of the above choices.
  89. .PP
  90. The \fIprefix\fR argument may be used to specify the first few letters
  91. of the last component of the path name generated by \fBtempnam\fR.
  92. \fBTempnam\fR dynamically allocates space for the name
  93. using \fBmalloc\fR.  It is the responsibility of the caller to
  94. release this storage by passing the returned string to \fBfree\fR
  95. when it is no longer needed.
  96. .SH KEYWORDS
  97. file name, temporary, unique
  98. @
  99.  
  100.  
  101. 1.1
  102. log
  103. @Initial revision
  104. @
  105. text
  106. @d9 1
  107. a9 1
  108. ' $Header: /sprite/lib/forms/RCS/proto.man,v 1.1 88/12/29 17:09:50 ouster Exp $ SPRITE (Berkeley)
  109. d15 1
  110. a15 1
  111. tmpnam, tmpname \- Generate unique names for temporary files
  112. @
  113.